Modify Customer User
This API is used to used to to update user details.
| HTTP URL | |
|---|---|
| PATCH | api/v2/customer/{id}/user/{id} |
NOTE: Request should contain only elements which require modification. Empty elements denote overridden of the existing value with a NULL value.
Eligibility
The Requester is eligible to request and receive information on own customer or sub-customers.
API Request
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| role | String | M | User role. ENUM valid values: ROLE_SUPER_ADMIN, ROLE_USER, ROLE_READ_ONLY, ROLE_SUPPORT, ‘ROLE_SUPER_ADMIN+IMPERSONATOR |
API Response
Response Structure
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| errorCode | String | O | Failure code. |
| errorMessage | String | O | Failure message. |
| content | Object | O | Array of main response body object displayed when an API call was successful. For a failure, it will be empty. |
| pageable | Object | O | Paging information object displayed when an API call was successful. For a failure, it will be empty. |
Content Data Objects
| Element | Type | M/O/CM | Description |
|---|---|---|---|
| requestId | UUID | M | User universal unique identity |
Pageable data objects
| Element | Type | M/O/CM | Description |
|---|---|---|---|
| page | Numeric | M | Page number |
| size | Numeric | M | Page size. Number of requested elements per page |
| totalPages | Numeric | M | Total amount of available pages per requested page size |
| totalElements | Numeric | M | Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
| Code | Message |
|---|---|
| GLOBAL_1001 | Service unavailable. Please try again |
| CUSTOMER_1002 | Customer does not exist |
Examples
Request Body
Copy
{
"role": "ROLE_SUPER_ADMIN"
}
Response Body: Success ACK
Copy
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b371"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}
Response Body: Failure NAK
Copy
{
"errorCode": "AUTH_1030",
"errorMessage": "Invalid user ID",
"content": "",
"pageable": ""